Menu Functions

Description

Functions for working with menus in a desktop interface.

Name
Description
ui_cut_branch Function

Get tree underneath a branch of the menu.

UI_EXPAND_BRANCHES Function

Expand branches - lines containing {=<expr>} get expanded to include lines generated.

UI_MENU_COMMANDS_GET Function

Return the end-commands from a menu tree.

UI_MENU_ITEM_GET Function

Returns the state of the menu item (appended - D=disable E=Enable C=check U=Unchecked X=using default).

UI_MENU_ITEM_SET Function

Override a menu items enable or checked state (flags E=enable D=disable C=checked U=unchecked X=remove overrides).

UI_MENU_KEYS_GET Function

Return a pairing of keys and commands from a menu tree.

UI_POP_MENU_HEIGHT Function

The UI_POPUP_MENU_HEIGHT() function returns the height of a menu.

UI_POPUP_MENU Function

The UI_POPUP_MENU() displays a menu and returns the user's selection in both Result and a_command. Displays a Popup menu based on passed in menu format - can also augment active top level menu.

ui_popup_menu_height Function

Get the height of a popup menu.

UI_POPUP_MENU_WIDTH Function

The UI_POPUP_MENU_WIDTH() function returns the width of a popup menu (with optional height restriction).

UI_POPUP_STYLED_MENU Function

The UI_POPUP_STYLE_MENU() displays a popup menu that has its own style. It returns the user's selection in both Result and a_command.

ui_top_branch Function

Get just the top branch of a tree (or menu). branchformat: I=Item,N=number,K=kids.

UI_TOP_MENU Function

Displays menu in main window, provide action code - if no arguments, then switch to 'no' menu.

UI_TOP_MENU_COMMAND Function

Send a command to the current top menu's command handler.

UI_TOP_MENU_HEIGHT Function

The UI_TOP_MENU_HEIGHT() function gets the height of a top menu (with optional width restriction).

UI_TOP_MENU_HOTKEYS Function

Register an invisible key handler - menu that exists only to process keys.

UI_TOP_MENU_HOTKEYS_RESTORE Function

Restore hotkeys that were saved (throws away any new ones that were defined).

ui_top_menu_hotkeys_save Function

Save hotkeys because we are going to override the hotkeys with a dialog context.

ui_top_menu_need_buttons Function

Returns true of top menu needs to display buttons.

UI_TOP_MENU_WIDTH Function

Get the width of a top menu.

UI_UTIL_MENU_DATA_DECODE Function

Decode embedded menu DATA.

UI_UTIL_MENU_DATA_ENCODE Function

Encode embedded menu DATA.